Gỡ lỗi Coroutine Python: Làm chủ Chế độ Gỡ lỗi Asyncio

Đầu ra này cho thấy rằng ValueError đã được đưa ra trong Task-1 và không được xử lý đúng cách.

Ví dụ thực tế về Gỡ lỗi với Chế độ Gỡ lỗi Asyncio

Hãy xem xét một số ví dụ thực tế về cách sử dụng chế độ gỡ lỗi asyncio để chẩn đoán các sự cố phổ biến:

1. Phát hiện các Socket chưa đóng

Hãy xem xét mã sau đây tạo một socket nhưng không đóng nó đúng cách:

            import asyncio
import socket

async def handle_client(reader, writer):
    data = await reader.read(100)
    message = data.decode()
    addr = writer.get_extra_info('peername')
    print(f"Received {message!r} from {addr!r}")

    print(f"Send: {message!r}")
    writer.write(data)
    await writer.drain()

    # Missing: writer.close()

async def main():
    server = await asyncio.start_server(
        handle_client,
        '127.0.0.1',
        8888
    )

    addr = server.sockets[0].getsockname()
    print(f'Serving on {addr}')

    async with server:
        await server.serve_forever()

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

Khi bạn chạy mã này với chế độ gỡ lỗi được bật, bạn sẽ thấy ResourceWarning cho biết một socket chưa đóng:

            ResourceWarning: unclosed <socket.socket fd=4, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=6, laddr=('127.0.0.1', 8888), raddr=('127.0.0.1', 54321)>
            

              
                Copy
              
            
          

Để khắc phục điều này, bạn cần đảm bảo rằng socket được đóng đúng cách, ví dụ: bằng cách thêm writer.close() vào coroutine handle_client và chờ nó:

                writer.close()
    await writer.wait_closed()
            

              
                Copy
              
            
          

2. Xác định callback chậm

Giả sử bạn có một coroutine thực hiện một thao tác chậm:

            import asyncio
import time

async def slow_function():
    print("Starting slow function")
    time.sleep(2)
    print("Slow function finished")
    return "Result"

async def main():
    task = asyncio.create_task(slow_function())
    result = await task
    print(f"Result: {result}")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

Mặc dù đầu ra gỡ lỗi mặc định không xác định trực tiếp các callback chậm, nhưng việc kết hợp nó với việc ghi nhật ký cẩn thận và các công cụ lập hồ sơ (như cProfile hoặc py-spy) cho phép bạn thu hẹp các phần chậm trong mã của mình. Hãy xem xét việc ghi lại dấu thời gian trước và sau các thao tác có khả năng chậm. Các công cụ như cProfile sau đó có thể được sử dụng trên các lệnh gọi hàm đã được ghi lại để cô lập các nút thắt cổ chai.

3. Gỡ lỗi Hủy bỏ Tác vụ

Hãy xem xét một tình huống trong đó một tác vụ bị hủy đột ngột:

            import asyncio

async def worker():
    try:
        while True:
            print("Working...")
            await asyncio.sleep(0.5)
    except asyncio.CancelledError:
        print("Worker cancelled")

async def main():
    task = asyncio.create_task(worker())
    await asyncio.sleep(2)
    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("Task cancelled in main")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

Đầu ra gỡ lỗi sẽ hiển thị tác vụ đang bị hủy:

            asyncio | execute <Task pending name='Task-1' coro=<worker() running at example.py:3> started at example.py:16>
Working...
Working...
Working...
Working...
asyncio | Task-1: cancelling
Worker cancelled
asyncio | Task-1: cancelled by <Task finished name='Task-2' coro=<main() done, defined at example.py:13> result=None>
Task cancelled in main
            

              
                Copy
              
            
          

Điều này xác nhận rằng tác vụ đã bị hủy bởi coroutine main(). Khối except asyncio.CancelledError cho phép dọn dẹp trước khi tác vụ bị chấm dứt hoàn toàn, ngăn chặn rò rỉ tài nguyên hoặc trạng thái không nhất quán.

4. Xử lý Ngoại lệ trong Coroutine

Xử lý ngoại lệ thích hợp là rất quan trọng trong mã bất đồng bộ. Hãy xem xét ví dụ sau với một ngoại lệ chưa được xử lý:

            import asyncio

async def divide(x, y):
    return x / y

async def main():
    result = await divide(10, 0)
    print(f"Result: {result}")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

Chế độ gỡ lỗi sẽ báo cáo một ngoại lệ chưa được xử lý:

            asyncio | Task exception was never retrieved
future: <Task finished name='Task-1' coro=<main() done, defined at example.py:6> result=None, exception=ZeroDivisionError('division by zero')>
            

              
                Copy
              
            
          

Để xử lý ngoại lệ này, bạn có thể sử dụng khối try...except:

            import asyncio

async def divide(x, y):
    return x / y

async def main():
    try:
        result = await divide(10, 0)
        print(f"Result: {result}")
    except ZeroDivisionError as e:
        print(f"Error: {e}")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

Bây giờ, ngoại lệ sẽ được bắt và xử lý một cách duyên dáng.

Các phương pháp hay nhất để Gỡ lỗi Asyncio

Dưới đây là một số phương pháp hay nhất để gỡ lỗi mã asyncio:

• Bật Chế độ Gỡ lỗi: Luôn bật chế độ gỡ lỗi trong quá trình phát triển và thử nghiệm.
• Sử dụng Ghi nhật ký: Thêm ghi nhật ký chi tiết vào các coroutine của bạn để theo dõi luồng thực thi của chúng. Sử dụng logging.getLogger('asyncio') cho các sự kiện cụ thể của asyncio và trình ghi nhật ký của riêng bạn cho dữ liệu dành riêng cho ứng dụng.
• Xử lý Ngoại lệ: Triển khai xử lý ngoại lệ mạnh mẽ để ngăn chặn các ngoại lệ chưa được xử lý làm hỏng ứng dụng của bạn.
• Sử dụng Nhóm tác vụ (Python 3.11+): Các nhóm tác vụ đơn giản hóa việc xử lý và hủy bỏ ngoại lệ trong các nhóm tác vụ có liên quan.
• Lập hồ sơ mã của bạn: Sử dụng các công cụ lập hồ sơ để xác định các nút thắt cổ chai về hiệu suất.
• Viết Bài kiểm tra đơn vị: Viết các bài kiểm tra đơn vị kỹ lưỡng để xác minh hành vi của các coroutine của bạn.
• Sử dụng Gợi ý kiểu: Tận dụng các gợi ý kiểu để phát hiện sớm các lỗi liên quan đến kiểu.
• Cân nhắc sử dụng trình gỡ lỗi: Các công cụ như `pdb` hoặc trình gỡ lỗi IDE có thể được sử dụng để từng bước thực hiện mã asyncio. Tuy nhiên, chúng thường kém hiệu quả hơn chế độ gỡ lỗi với việc ghi nhật ký cẩn thận do bản chất của việc thực thi bất đồng bộ.

Các kỹ thuật gỡ lỗi nâng cao

Ngoài chế độ gỡ lỗi cơ bản, hãy xem xét các kỹ thuật nâng cao sau:

1. Chính sách vòng lặp sự kiện tùy chỉnh

Bạn có thể tạo các chính sách vòng lặp sự kiện tùy chỉnh để chặn và ghi nhật ký các sự kiện. Điều này cho phép bạn có được quyền kiểm soát chi tiết hơn nữa đối với quy trình gỡ lỗi.

2. Sử dụng các Công cụ gỡ lỗi của Bên thứ ba

Một số công cụ gỡ lỗi của bên thứ ba có thể giúp bạn gỡ lỗi mã asyncio, chẳng hạn như:

• PySnooper: Một công cụ gỡ lỗi mạnh mẽ, tự động ghi lại việc thực thi mã của bạn.
• pdb++: Một phiên bản cải tiến của trình gỡ lỗi pdb tiêu chuẩn với các tính năng nâng cao.
• asyncio_inspector: Một thư viện được thiết kế riêng để kiểm tra các vòng lặp sự kiện asyncio.

3. Vá lỗi Monkey (Sử dụng thận trọng)

Trong các trường hợp cực đoan, bạn có thể sử dụng vá lỗi monkey để sửa đổi hành vi của các hàm asyncio cho mục đích gỡ lỗi. Tuy nhiên, điều này nên được thực hiện một cách thận trọng, vì nó có thể gây ra các lỗi tinh vi và khiến mã của bạn khó bảo trì hơn. Điều này thường không được khuyến khích trừ khi thực sự cần thiết.

Kết luận

Gỡ lỗi mã bất đồng bộ có thể đầy thách thức, nhưng chế độ gỡ lỗi asyncio cung cấp các công cụ và thông tin chi tiết có giá trị để đơn giản hóa quá trình này. Bằng cách bật chế độ gỡ lỗi, giải thích đầu ra và làm theo các phương pháp hay nhất, bạn có thể xác định và giải quyết hiệu quả các vấn đề phổ biến trong các ứng dụng bất đồng bộ của mình, dẫn đến mã mạnh mẽ và hiệu quả hơn. Hãy nhớ kết hợp chế độ gỡ lỗi với ghi nhật ký, lập hồ sơ và thử nghiệm kỹ lưỡng để có kết quả tốt nhất. Với thực hành và các công cụ phù hợp, bạn có thể làm chủ nghệ thuật gỡ lỗi các coroutine asyncio và xây dựng các ứng dụng bất đồng bộ có khả năng mở rộng, hiệu quả và đáng tin cậy.